Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🌳 Stub endpoints for backend client 🌳 #63

Merged
merged 7 commits into from
Jan 3, 2025

Conversation

henriettelienrebnor
Copy link
Contributor

@henriettelienrebnor henriettelienrebnor commented Jan 3, 2025

Aim of the PR

This PR fixes AB#209162

Stubbed the endpoints that is needed for the dexpi demo.

NB

A lot of files changed since a new project is added! The main files are the following:

  • The contents of Backend/Model
  • Program.cs in Backend

Also did dotnet format which formatted the files in the other projects in the Boundaries solution.

Implementation

Created a new web project in the Boundaries solution and created minimal api's for stubbing the endpoints.
Also made made a proposal for two new DTO's: Node and CommissioningPackage.
The endpoints cover the following operations:

  • adding node as internal or boundary
  • removing node as internal or boundary
  • getting adjacent nodes of a node
  • updating commissioning package color, name, and id.
  • adding commissioning package
  • deleting commissioning package
  • getting a commissioning package

It is not created a basic endpoint for querying the triplestore, this is intentional because the existing endpoints cover all necessary actions. Also, exposing a generic endpoint might make the frontend harder to maintain. If more specific endpoints is required then the backend should create these.

Type of change

  • Bug fix
  • New feature
  • Breaking change
  • This change requires a documentation update

@markus-ap
Copy link
Contributor

markus-ap commented Jan 3, 2025

🎉 Snyk checks have passed. No issues have been found so far.

security/snyk check is complete. No issues have been found. (View Details)

license/snyk check is complete. No issues have been found. (View Details)

code/snyk check is complete. No issues have been found. (View Details)

Copy link
Contributor

@eoye eoye left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the two DTOs and the endpoints, I think this is all we need for now! Also love how simple and clean the minimal API looks, great job!🙌

@henriettelienrebnor henriettelienrebnor merged commit f50c3be into main Jan 3, 2025
5 checks passed
@henriettelienrebnor henriettelienrebnor deleted the story/209162-stub-endpoints branch January 3, 2025 13:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants